Package com.vasco.orchestration.client

Interface Orchestrator

public interface Orchestrator
The Orchestrator interface is the entry point of the Orchestration SDK. It allows the execution of orchestration commands providing seamless two-factor authentication.

Creation

You can create an orchestrator using the internal class Orchestrator.Builder. This builder will provide you with the minimal required configuration for the orchestrator.

Subsequent configurations can be done during the lifecycle of the Orchestrator object by using the related setters.

Provisioning

In order to provision the SDK with a DIGIPASS instance, a call to startActivation(ActivationParams activationParams) must be performed.
All subsequent orchestration commands transmission shall be done through the execute(String) method.

Notification registration

In order to provision the SDK with a DIGIPASS instance, a call to startNotificationRegistration(NotificationRegistrationParams activationParams) must be performed.

Commands

All subsequent orchestration commands transmission shall be done through the execute(String) method.

  • Field Details

  • Method Details

    • execute

      void execute(@NonNull String command)
      Executes an Orchestration Command provided by the server.
      Parameters:
      command - the Orchestration Command provided by the server, as an hexadecimal string.

    • startActivation

      void startActivation(@NonNull ActivationParams activationParams)
      Starts the activation process.

    • startNotificationRegistration

      void startNotificationRegistration(@NonNull NotificationRegistrationParams notificationRegistrationParams)
      Starts registering for push notifications.

    • startChangePassword

      void startChangePassword(@NonNull ChangePasswordParams changePasswordParams)
      Starts password changing.

    • startLocalAuthentication

      void startLocalAuthentication(@NonNull LocalAuthenticationParams localAuthenticationParams)
      Starts a local authentication process. This method is used to generate a one-time password using a specified protection type and an optional challenge.

    • startLocalTransaction

      void startLocalTransaction(@NonNull LocalTransactionParams localTransactionParams)
      Starts a local transaction process. This method is used to generate a signature from specified data fields and using a specified protection type.

    • getUserManager

      UserManager getUserManager()
      Provides a UserManager object that allows manipulation of users and DIGIPASSes.
      Returns:
      a UserManager object

    • getCDDCDataFeeder

      CDDCDataFeeder getCDDCDataFeeder()
      Provides a CDDCDataFeeder object that allows integrator to set CDDC data values .
      Returns:
      a CDDCDataFeeder object

    • getCDDCMessage

      CDDCMessage getCDDCMessage(CDDCMessageParams cddcMessageParams)
      Parameters:
      cddcMessageParams - CDDCMessageParams object
      Returns:
      a CDDCMessage object, with the CDDC data in clear text or encrypted.

    • setRemoteAuthCallback

      void setRemoteAuthCallback(@NonNull RemoteAuthenticationCallback remoteAuthenticationCallback)
      Sets the callback to be notified about remote authentication events.

    • setRemoteTranCallback

      void setRemoteTranCallback(@NonNull RemoteTransactionCallback remoteTransactionCallback)
      Sets the callback to be notified about remote transaction validation events.

    • setErrorCallback

      void setErrorCallback(@NonNull OrchestrationErrorCallback orchestrationErrorCallback)
      Sets the callback to be notified of errors.

    • setWarningCallback

      void setWarningCallback(OrchestrationWarningCallback orchestrationWarningCallback)
      Sets the callback called when warnings happen.

    • setUserAuthenticationCallback

      void setUserAuthenticationCallback(@NonNull UserAuthenticationCallback userAuthenticationCallback, UserAuthenticationCallback.UserAuthentication[] types)
      Sets the callback to override the way a user authentication will be displayed.
      Parameters:
      userAuthenticationCallback - a UserAuthenticationCallback object
      types - an array of UserAuthenticationCallback.UserAuthentication the type of user authentication that will be overridden.